Document boolean values in V3 Search API query value field#545
Open
kstenson wants to merge 1 commit into
Open
Conversation
The search query `value` field accepts boolean values, but the spec only listed string, integer and array. This documents boolean as a valid search value across all documented versions, covering the conversations, contacts and tickets search endpoints (the schema is shared). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why?
The V3 Search API query
valuefield accepts boolean values, but the reference only listedstring,integerandarray. That left a gap: filtering a boolean field with the!=operator is valid, but the docs gave no indication booleans were accepted search values.How?
Added
booleanto the shared search predicatevalueschema and noted in its description that boolean fields accepttrue/false(and their string forms). The schema is shared across the conversations, contacts and tickets search endpoints, and the change is applied to every documented version.Generated with Claude Code